CVSTGUITimer Class Reference

A timer class, which posts timer messages to CBaseObjects. More...

Inheritance diagram for CVSTGUITimer:
Inheritance graph
[legend]
Collaboration diagram for CVSTGUITimer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 CVSTGUITimer (CBaseObject *timerObject, int32_t fireTime=100)
virtual bool start ()
 starts the timer
virtual bool stop ()
 stops the timer, returns wheather timer was running or not
virtual bool setFireTime (int32_t newFireTime)
 in milliseconds
int32_t getFireTime () const
 in milliseconds
Reference Counting Methods



virtual void forget ()
 decrease refcount and delete object if refcount == 0
virtual void remember ()
 increase refcount
virtual int32_t getNbReference () const
 get refcount
Message Methods



virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)

Static Public Attributes

static IdStringPtr kMsgTimer = "timer fired"
 message string posted to CBaseObject's notify method

Protected Member Functions

 ~CVSTGUITimer ()

Protected Attributes

int32_t fireTime
CBaseObjecttimerObject
void * platformTimer

Detailed Description

A timer class, which posts timer messages to CBaseObjects.


Constructor & Destructor Documentation

CVSTGUITimer ( CBaseObject timerObject,
int32_t  fireTime = 100 
)
~CVSTGUITimer (  )  [protected]

Member Function Documentation

virtual void forget (  )  [inline, virtual, inherited]

decrease refcount and delete object if refcount == 0

int32_t getFireTime (  )  const [inline]

in milliseconds

virtual int32_t getNbReference (  )  const [inline, virtual, inherited]

get refcount

virtual CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
) [inline, virtual, inherited]
virtual void remember (  )  [inline, virtual, inherited]

increase refcount

bool setFireTime ( int32_t  newFireTime  )  [virtual]

in milliseconds

bool start (  )  [virtual]

starts the timer

bool stop (  )  [virtual]

stops the timer, returns wheather timer was running or not


Member Data Documentation

int32_t fireTime [protected]
IdStringPtr kMsgTimer = "timer fired" [static]

message string posted to CBaseObject's notify method

void* platformTimer [protected]
CBaseObject* timerObject [protected]

The documentation for this class was generated from the following files:

Generated on Fri Nov 22 11:09:58 2013 for VSTGUI by  doxygen 1.6.1